You are here: Licensing the Nuance OmniPage Capture SDK > Distributing Runtime Licenses > Distributing Fixed Volume Licenses

Distributing Fixed Volume Licenses (Desktop Runtimes)

Fixed Volume licenses are tied to the hardware of the end user's computer, therefore they must be activated on the end user's machine.

For this type of licensing scheme, Nuance Licensing Service installation is not required starting from Nuance OmniPage Capture SDK v20. The OmniPage License Manager OPLicMgr.exe command-line tool takes the role of the formerly used Nuance Licensing Tool in the license activation. This tool has two versions:

OPLicMgr_s.exe: silent command-line tool that displays no user interface and does not start a command prompt. You can use it in your installer application to activate your user's license keys, or do all other license handling tasks, without user intervention. This version is recommended, especially if your user's machine has internet connection, since by executing this tool in your installer you can make the activation process much simpler for your end users.
OPLicMgr.exe: regular command-line tool that your user can use to activate or move the licenses. The user must launch a command prompt from the Start menu by typing cmd and use the commands documented below. If this alternative is used, you have to provide a proper description to your users on how to activate your product using the tool.

The commands below can be performed both by OPLicMgr or OPLicMgr_s, but the code fragments are given with OPLicMgr only. Use OPLicMgr_s in the same way in your installer. This silent version does not display anything on screen. Your installer can learn if the commands succeeded or failed by examining the return code: 0 means success, other values mean different errors. Textual progress report and problem notification is handled by generating two log files if the following command line options are specified:

-o filename: generates a log file with all the messages about the result of the operation
-e filename: generates an error log file with important error messages

Run OPLicMgr with an empty command line, or with the -h option to learn more about these, and many other options.

If you want your users to run OPLicMgr, you should add code to your installer program to include the path to the OPLicMgr.exe program in the PATH environment variable. This is not necessary if your installer starts OPLicMgr_s.exe with a full path.

Activation process

The following steps are required to activate your product depending on whether your users have internet connection on their machine or not.

Your installer (or your users) can test if the computer has internet access to the Nuance activation site by running the OPLicMgr -test command.

If the program writes Test connection succeeded (or the silent OPLicMgr_s tool returns 0), you can use the first option.
In case of Test connection failed (or non 0 return code) you can jump to the second option (Activation without internet). However, if you are sure that you have internet connection on the target computer, check with your network administrator whether there is a proxy server on your LAN. You may have to configure OPLicMgr for use of proxy; see details below at Proxy information section.

With internet

The activation process is very simple in this case; a single command is required only on your user's machine:

OPLicMgr -activate SERIALNUMBER (i.e. start a cmd command prompt from the Start menu, type this command and hit Enter.)

Where SERIALNUMBER is the 22 character long runtime license key from the Nuance Fulfillment email regarding your order. If you give your user more than one license keys, write them all in the command line following the -activate command separated with a space.

Without internet

Run OPLicMgr -nonet -activate SERIALNUMBER on the user's runtime machine, where SERIALNUMBER is the 22 character long license key, or several license keys separated with a space.
A new file named OP_Activate.lcxp is generated in the Documents folder. This file contains all the information required for activation on a different PC. Save this license package to a removable media.
Move your saved file to another computer with Internet connection.
Go to the following link: http://licenses.nuance.com/csdkactivation
Follow the instructions on that web page to activate the license package.
Download/Save the activated lcxp file (usually named licenses.lcxp) to a portable media and move it back to the target computer.
Run OPLicMgr -load licenses.lcxp where licenses.lcxp is the name of the activated license pack file. You must run this command in the same folder where the file is copied, or you must use the full path name to the lcxp file. (For example, if the command prompt opens in your Personal folder, but the file is copied to the Documents folder, you must use the OPLicMgr -load Documents\licenses.lcxp command.)

Proxy information

If the user's machine has internet connection but it requires use of a proxy, proxy related information can be inserted in the OPLicMgr.cfg.txt file in the user's personal folder. This file is generated the first time when OPLicMgr is run. To access this configuration file, go to the Start menu and open your Personal folder by clicking your name. Ask your system administrator to edit the configuration file.

Moving licenses

Moving licenses is also possible, for example in case of hardware upgrade. The steps required depend on whether your user's target computer has internet access or not (the source computer does not need internet access) :

Run OPLicMgr -move OP_Move.lcxp all on the source machine to prepare all the licenses for moving to the target machine. If you want to move some of the licenses only, write their 22 character long license keys in place of all in the previous command.
The previous command created the license package OP_Move.lcxp. Save this file to a removable media and take it to the target computer.

If the target computer has internet access:

Run OPLicMgr -load OP_Move.lcxp on the target computer. (If the file is copied to a different folder, use the full path name to it.)

If the target computer does not have internet access:

Run OPLicMgr -nonet -load OP_Move.lcxp on the target computer. (If the file is copied to a different folder, use the full path name to it.)
A new file named OP_Activate.lcxp is generated in the Documents folder. This file contains all the information required for moving the licenses and activating them on the target machine.
Save this license package to a removable media and move it to another computer with Internet connection. Activate it as described in Activation process without internet section above.
Run OPLicMgr -load licenses.lcxp on the target machine. licenses.lcxp is the name of the activated license pack file. You must run this command in the same folder where the file is copied, or you must use the full path name to the lcxp file.

Special deployments using NLCL.cfg file

The original design of Nuance License Management system assumes that NCLS/NCLT and OpLicMgr utilities are not used on the same computers.

To avoid licensing issues in special deployment cases when both the NCLS/NCLT-activated and OpLicMgr-activated licenses are present simultaneously, we introduced the use of NLCL.cfg file in Desktop Runtime distributions (deployments), starting from version 20.3.

To ensure that your deployment works properly even if other CSDK-based applications install NCLS/NCLT, it is recommended to add a special NLCL.cfg file to your deployment.

In this case the NLCL.cfg file must contain only a single, 8-character code word: „oplicmgr”.

For the possible locations of NLCL.cfg file and further details of its entries refer to the Licensing improvements section of the Nuance OmniPage Capture SDK 20.3 Release Notes (ReadMeEng.htm).